> For the complete documentation index, see [llms.txt](https://star-generator.gitbook.io/star-generator-docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://star-generator.gitbook.io/star-generator-docs/about-stargenerator.md).

# About StarGenerator

StarGenerator is a Minecraft crafting-table plugin for custom production machines. It lets server owners define placeable table items, ModelEngine, MythicMobs, or BetterModel table entities, custom crafting grids, rewards, energy usage, upgrades, recipe pages, recipe lists, vanilla and CraftEngine crafting recipes, and a local WebUI editor from YAML files.

This documentation is written for StarGenerator `1.1.4-Alpha`.

## What StarGenerator Provides

* Custom placeable crafting tables and machines.
* Per-table recipe pages, recipe lists, and craft method pages.
* Reward storage and output handling.
* Optional energy storage, fuel items, and energy progress bars.
* Per-table craft cost modifiers for time and energy.
* Recipe icon placeholders for craft time, energy cost, total energy, and stored machine energy.
* Central tooltip detail settings for craft progress and energy progress bars.
* Vanilla crafting recipe registration, including recipes that output StarGenerator table items.
* CraftEngine item paths, item catalog entries, recipe ingredients, rewards, and external CraftEngine crafting recipes.
* Starter Ice Cream content for ItemsAdder, Nexo, and Oraxen, with the same StarGenerator recipe system also supporting CraftEngine item paths.
* ModelEngine, MythicMobs, and BetterModel entity support with fallback interaction for missing or renamed visual models.
* MythicMobs crafting triggers and StarGenerator MythicMobs item mechanics.
* Construction-state table placement with building, ready-to-activate, and active states.
* Runtime cache backups, suspicious-cache quarantine, and deletion tombstones to reduce table-loss risk.
* A token-protected local WebUI editor for table, recipe, group, and pack YAML files.

## Requirements

* Java 21.
* Minecraft server API compatible with Spigot/Paper `1.21.x`.
* StarLibs is required.
* Optional integrations: PlaceholderAPI, MythicMobs, ModelEngine, BetterModel, ItemsAdder, Nexo, Oraxen, CraftEngine, MMOItems.

ItemsAdder, Nexo, and Oraxen are alternative custom-item providers. Most servers should install one of them for the bundled Starter Ice Cream resources.

CraftEngine is supported as a custom item and external crafting recipe provider. It is optional and can be used for your own CraftEngine items even when the bundled Starter Ice Cream resources are generated for another item provider.

## Recommended Reading Order

1. Installation
2. Quick Start
3. Commands and Permissions
4. Item Paths
5. Table YAML
6. Recipe YAML
7. WebUI Editor
8. Energy System
9. Craft Cost Modifiers
10. Placeholders
11. MythicMobs Integration
12. Table Entity Models
13. Runtime Cache & Recovery


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://star-generator.gitbook.io/star-generator-docs/about-stargenerator.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.